home *** CD-ROM | disk | FTP | other *** search
/ How to Get Online 1996 Spring / HOW2GON.ISO / mac / E-Mail / MacBiff ƒ / README < prev   
Encoding:
Text File  |  1994-01-22  |  14.2 KB  |  395 lines  |  [TEXT/ALFA]

  1.  
  2.  
  3.  
  4.  MacBiff v1.01 README file
  5.  
  6.      THIS RELEASE VERSION HAS CHANGES THAT WILL CAUSE OLDER CONFIGURATIONS
  7.      TO DROP MAIL!!! PLEASE READ ALL OF THIS FILE AND MAKE THE NEEDED CHANGES
  8.      TO UPDATE YOUR UN?X ACCOUNT SO THIS DOES NOT HAPPEN.
  9.  
  10.  
  11.  ©1994 the Student Chapter of the Association for Computing Machinery
  12.    at the University of Illinois, Urbana - Champaign and SigSoft
  13.    (the Special Interest Group for Software Development), the UIUC 
  14.    Department of Computer Science, UIUC, and most likely a bunch
  15.    of other people I don't know.
  16.    
  17.    ACM at UIUC RESERVES ALL DISTRIBUTION RIGHTS.
  18.    
  19.    Eudora® is a registered trademark of the University of Illinois Board
  20.     of Trustees.  
  21.  
  22.  
  23.  
  24. What is MacBiff / rbiff ?
  25. -------------------------
  26.  
  27.     MacBiff/rbiff are two programs that will notify a Mac user when
  28.     new email comes in on their UN?X account.
  29.     
  30.     The MacBiff/rbiff project started a few months ago as a new project
  31.     idea at one of our weekly SigSoft meetings.  "I want it so my Mac
  32.     makes cools sounds when I get mail, just like all the other people
  33.     with workstations on their desks" - Chris Trimble.  And so a project
  34.     was born.  The two main features of MacBiff are:
  35.     
  36.     + Totally Passive Operation
  37.     
  38.     + Requires no permissions to set up
  39.     
  40.     Because most of the students here read mail off of UN?X boxes that 
  41.     are shared among many many users, we could not leave a deamon running
  42.     on the UN?X machine (background processes are highly frowned upon) so
  43.     we had to keep opperation totally passive.  We didn't want to have to
  44.     keep restarting rbiff every time a lab workstation crashed either.
  45.     The resulting two programs allow a user to configure their UN?X account
  46.     so that rbiff is only run when new mail comes in, and needs no
  47.     special permissions to be setup or run.
  48.     
  49.     The basic idea is that when ever your UN?X account gets mail,
  50.     it runs rbiff via a piped .forward file (don't worry if you don't
  51.     know what that means).  rbiff goes through your .rbiffrc file and
  52.     sends out a message over the network to every computer listed.
  53.     When MacBiff is running it sits and watchs the network for any
  54.     messages.  When one comes it can be configued to do a few different
  55.     things including playing a noise.  MacBiff requires System 7 & MacTCP.
  56.     
  57.     MacBiff is not designed as a mail reader, mailbox quere system, or
  58.     anything more than just letting you know about new mail.  There
  59.     are many other programs avaliable for the Mac that are MUCH better.
  60.     If you are looking for a way to read UN?X mail from a Macintosh I
  61.     would personally suggest Eudora by Steve Dorner.  Eudora v1.4 can
  62.     be found on ftp.cso.uiuc.edu, and v2.0 is commerically avaliable from
  63.     Qualcomm Inc.  Mail eudora-info@qualcomm.com for more info.
  64.     
  65.     MacBiff is "donation-ware".  If you think it is the way coolest thing
  66.     you have ever seen, ACM@UIUC will happily take donations.  You decide
  67.     how much it is worth to you.  On the other hand, if it crashes your
  68.     server and you lose all your mail for the next 8 months, don't come
  69.     to us... To find out more about ACM@UIUC feel free to mail acm@uiuc.edu.
  70.     To get in touch with the developers with questions/comments/bugs/massive
  71.     crashes, mail macbiff@uiuc.edu.
  72.     
  73.     
  74. How does it work ?
  75. ------------------
  76.  
  77.     if you set up a .forword file with a pipe instead of an address
  78.     your mail is piped through whatever program is in your .forward
  79.     file.  This means that you can put rbiff in your .forward file so
  80.     that whenever mail comes it gets piped into rbiff.  rbiff will
  81.     extract the subject, and who the message was from.  If you are
  82.     running procmail or elm filter you an also have rbiff run after
  83.     filtering.  Once rbiff has the information from the mail that
  84.     it needs, rbiff looks at your .rbiffrc file and sends a single UDP/IP
  85.     message out to every host and port listed in the .rbiffrc file.
  86.     If MacBiff is running it will pickup the UDP/IP packets and try
  87.     to extract the information from the packet.  It will then optionally
  88.     filter the message and notify the user.
  89.     
  90.  
  91. Setting up MacBiff
  92. ------------------
  93.  
  94.     MacBiff is just like any other Macintosh application.  It requires
  95.     about 50K worth of heap space, but will grab free memory from the
  96.     system when it needs to for stuff like playing sounds.  MacBiff stores
  97.     user settings interally, so it need to be run from media that can be
  98.     written to.  To start it checking for mail, just run it.
  99.     
  100. Menus:  These are fairly obvious...
  101.     
  102.     (Apple):    About MacBiff...
  103.     
  104.                         Brings up the About Box.
  105.     
  106.     File:        Preferences...
  107.  
  108.                         Opens preference window.
  109.                         
  110.                 Review Mail...
  111.                 
  112.                         Opens mail message box.  Dimmed if
  113.                         no new mail has come in.
  114.                         
  115.                 Quit
  116.                 
  117.                         Quits MacBiff
  118.  
  119.  
  120.  
  121. Preference Box:
  122.  
  123.     Collect all incoming mail
  124.     Collect mail only for <name>
  125.     
  126.         If the top choice is active, MacBiff will display messages for all
  127.         mail.  If the bottom choice is active, and a name is entered in the
  128.         text box, only mail for that user is displayed and other mail is
  129.         discarded.  This is for use on Macs that may appear in the .rbiffrc
  130.         of more than one user.  Especially useful for Macs used by more
  131.         than one person.
  132.  
  133.     Remember information about new mail
  134.     Simply indicate new mail has arrived
  135.     
  136.         The top choice will allow you to look at critical information
  137.         about the new mail via the "Review Mail..." menu item or the
  138.         automatic option (below).  The bottom option will cause
  139.         MacBiff to do the new mail actions and then discare then mail
  140.         information.
  141.         
  142.     New mail actions
  143.     + Play Sound
  144.         Plays the sound sellected from the pop-up menu to the right.
  145.         The menu has all sounds in the System suitcase plus any in
  146.         the MacBiff resource fork, for those hackers out there.
  147.     + Show Icon in Menu Bar
  148.         This will cause the MacBiff icon to flash in the application menu
  149.         until you look at the new mail information.
  150.     + Show Dialog Box
  151.         Brings up a dialog box that says "You Have New Mail."
  152.     + Tell Eudora to check mail
  153.         Has MacBiff send an AppleEvent to Eudora whenever new mail
  154.         comes in.  This causes Eudora to check for new mail on your
  155.         account.  MacBiff will not launch Eudora, it must be running.
  156.         If Eudora is not running, nothing is done.
  157.  
  158.     + Automatically Display New Mail
  159.         Will cause MacBiff to automatically bring up the mail info
  160.         window if there is mail info waiting to be read and the MacBiff
  161.         application is brought to the forground.
  162.         
  163.     Port <number>
  164.         This is used to set the port number that MacBiff looks at
  165.         for message information.  See a local network guru for more
  166.         information.  4545 is the defalt port for both MacBiff and
  167.         rbiff.  MacBiff can only watch one port at a time.
  168.         
  169. Mail Info window:
  170.  
  171.     Next
  172.         Displays next message to come in
  173.     Last
  174.         Displays previous message to come in
  175.     Clear All
  176.         Clears all messages from MacBiff.  This in no way effects the
  177.         mail in your account.
  178.     Clear
  179.         Clears current message from MacBiff.  Again, this in no way effects
  180.         the mail in your account.
  181.     Close
  182.         Closes the mail info window.  Can be opened with the "Review Mail..."
  183.         menu item.  If MacBiff has no messages left it will automatically
  184.         close the mail info window.
  185.         
  186.     Note: the "Time" that is displayed in the mail info window is the
  187.     time that the Mac got the new mail message, not the time the Email
  188.     was sent.
  189.  
  190.  
  191. Setting up rbiff
  192. ----------------
  193.  
  194.     This is a little more tricky.  It is assumed that you know enough
  195.     basic UN?X to get around and edit files.
  196.     
  197.     The basics of rbiff are these:
  198.     
  199.     <mail file> | rbiff
  200.     
  201.         Causes rbiff to read text in SMTP mail format from standard
  202.         in and send new mail messages in the ~/.rbiffrc file.
  203.     
  204.     To get rbiff working the first thing you need to do is compile
  205.     the rbiff.c program.  Once you have gotten the rbiff.c file to
  206.     your account you can compile it with the command:
  207.     
  208.   $ cc -o rbiff rbiff.c
  209.     
  210.     I have tested this under SunOS and it comiled under cc, gcc, and
  211.     gcc -ansi without errors.  It also compiled with cc on an SGI
  212.     and RS/6000.  Many of the beta testers have also compiled it on
  213.     various computers without problems.
  214.  
  215.     Once you have the rbiff program, stick it somewhere useful.  I keep
  216.     it in a dir called bin in my home dir along with any other personal 
  217.     programs.  Feel free to have a system admin put it somewhere more
  218.     public if many users are using it.
  219.     
  220.     Next you need to set up a .rbiffrc file.  This file must go in your
  221.     home dir.  The smallest .rbiffrc file is 3 lines long and is in the
  222.     format:
  223.  
  224. -=-=-=-=-=-
  225. <Full User Name>        = Name MacBiff uses to filter mail
  226. <Account Name>            = Reference name so you know what account to check
  227. <host name> <port #>    = host name, and port to send message to.
  228.  ....
  229. -=-=-=-=-=-
  230.  
  231.  
  232.     One of mine looks something like this:
  233.  
  234. -=-=-=-=-=-
  235. Jay Kreibich
  236. #
  237. #     Account:
  238. #
  239. Work SGI accont
  240. #
  241. #     Machine listngs:
  242. #
  243. acm2.cs.uiuc.edu 4545
  244. #  ACM development Mac
  245. #
  246. isr0283.urh.uiuc.edu 4545
  247. #  my computer in my dorm room
  248. #
  249. isr0324.urh.uiuc.edu 4545
  250. #  my PowerBook when it is at home
  251. #
  252. monet.beckman.uiuc.edu 4545
  253. #  a computer at work
  254. #
  255. homer.cs.uiuc.edu 4545
  256. #  my PowerBook when it is in the ACM office
  257. #
  258. -=-=-=-=-=-
  259.  
  260.     The first line is the name that MacBiff uses to filter with if
  261.     you have it set to "Collect Mail Only For:".  The account name
  262.     is whatever you want it to be.  This was added so that I can tell
  263.     if the new mail was to my work account, CS account, or general
  264.     student account.  Last is a list of as many hosts as you want
  265.     each with a port number.  rbiff will go through each host and 
  266.     signal to them at the specific port.  If you use IP addresses, 
  267.     things will go a little faster.  Lines that begin with the char
  268.     '#' are ignored.
  269.  
  270.     Last you need to set up a .forward file.  The easiest is somthing
  271.     like (including quotes):
  272.     
  273.     NOTE: THIS IS AN IMPORTANT CHANGE FROM THE BETA VERSIONS!!
  274.  
  275. -=-=-=-=-=-
  276. \jk, "| /home/users/jk/bin/rbiff"
  277. -=-=-=-=-=-
  278.  
  279.     The basic format would is this:
  280.     
  281. -=-=-=-=-=-
  282. \<login>, "| <full path to rbiff>/rbiff"
  283. -=-=-=-=-=-
  284.  
  285.     See the "forward" man page for more details.  The basic idea is that
  286.     the first "address" you are asking the mail system to forward your
  287.     mail to is yourself.  The "\" tells the mail system to ignore the
  288.     .forward file while sending the mail so that cycles can be avoided.
  289.     The second "address" you want the mail sent to is the rbiff program
  290.     as standard input.  This will cause the rbiff program to be run once
  291.     each time you get new.  Because you are not running rbiff from a shell,
  292.     it is a good idea to use the full path in your .forward file.
  293.  
  294. Tips:
  295.  
  296.     + Mail yourself 2 or 3 test messages to make sure you are not losing
  297.       mail, and that rbiff and MacBiff are set up right.
  298.  
  299.     + If you are using procmail or elm filter, be sure the mail gets
  300.       to the mailbox somehow... rbiff will not write it to the incoming
  301.       mailbox!!!
  302.     
  303.  
  304. Many Thanks Too:
  305. ----------------
  306.  
  307.     Christian Rathke, for testing out 3 or 4 differnt versions and
  308.         helping catch a few strange bugs.
  309.         
  310.     Steve Dorner, for giving me the answer to a bug that would have
  311.         taken 5 or 6 weeks to find on my own.  Also provided new
  312.         versions of Eudora to run beta tests with and pointing out
  313.         existing email protocols (which were not used... sorry!).
  314.     
  315.     Mike Brudenell, who sent me 6 or 7 patch files for rbiff.  Too
  316.         bad we ended up just trashing the whole program and rewriting
  317.         it from the beginning-- again.
  318.  
  319.     Charley Kline, for giving new ideas on how to handle .forward
  320.         files, and helping with early beta testing of v0.99.
  321.         
  322.     And, of course, the various ACM people around the office including
  323.     Chris Trimble who came up with the idea, Joel Jones our master of
  324.     all that is Mac, Frank "the" Beier for general support, Alan 
  325.     "is a" Braverman for the Cherry Coke and Simsons, Greg Brauer for
  326.     the "message for you, sir" sound clip, Mike "the" DUFF our ACM
  327.     chair, Amy Ryan for Elmo and interesting conversation, Jim Browne
  328.     and Eric Johnson for their help with MacTCP and networking in general,
  329.     and everyone else in SigSoft and ACM (especially Dan SIMMs) for
  330.     putting up with me as I tested the program forcing them to listening
  331.     to the "message for you, sir" sound clip at least 50 times a day and
  332.     me run around the office yelling about how MacTCP crashed the
  333.     machine again...
  334.  
  335.  
  336.  
  337. ACM at UIUC
  338. -----------
  339.     
  340.     ACM@UIUC is a Student Chapter of the Association for Computing Machinery
  341.     at the University of Illinois, Urbana - Champaign.  We are a student
  342.     organization open to undergrads and grad students interested in anything
  343.     that has to do with computers.  A majority of our membership are CS and
  344.     ECE majors, but there are everything from English to Bio majors here
  345.     too.  Our current membership is ~160 students.  ACM@UIUC puts out a
  346.     semi-monthly newsletter, _The Banks of the Boneyard_, with an average
  347.     distribution of 1000 copies.  Each of our 11+ SIGs, or Special Interest
  348.     Groups meets (usually) weekly to discuss projects and ideas related to
  349.     the topic of the SIG-- anything from SigMusic to SigVR.  For more
  350.     information on ACM@UIUC, mail acm@uiuc.edu.  Other sources of information
  351.     include our WWW server "http://sleepless.cs.uiuc.edu" and our anonymous
  352.     FTP site, ftp.cso.uiuc.edu, /ACM.
  353.     
  354.     
  355. Development
  356. -----------
  357.  
  358.     MacBiff was developed on ACM@UIUC's main Mac Development machine,
  359.     a 2 headed Quadra 700 20/100 running 7.1 and MacTCP 1.1.1 and 2.0.4.  
  360.     It was written with THINK C 6.01.  The UN?X side of things, rbiff,
  361.     was written at the Department of Computer Science (at UIUC) 
  362.     Instructional Lab, using SPARCstation IPXs running SunOS 4.1.2.
  363.     There has been talk about writing a Windoze client for PCs, but
  364.     I'm not the one to do it.  If you are interested in such a program
  365.     feel free to mail macbiff@uiuc.edu.
  366.  
  367.  
  368. Version History
  369. ---------------
  370.  
  371.     v0.3  -    First released named version.  Avaliable only through
  372.             email requests with limited public distribution.  Leaked
  373.             memory and had a very poor interface.
  374.             
  375.     v0.6  -    Total interface re-rewrite from v0.6.  Much more
  376.             configurable and much more friendly to the user.
  377.             Not released to the public.
  378.  
  379.     v0.9  -    Fixed memory leak that would happen if the Mac was
  380.             slammed by invalid packets.  Had fun testing this one.
  381.             Not released to the public.
  382.             
  383.     v0.99 - Added optional AppleEvents so that MacBiff could tell Eudora
  384.             to check for incoming mail.
  385.             Not released to the public.
  386.             
  387.     v1.0  -    Finished the About Box, Docs, and released.
  388.     
  389.             Found two major bugs within a few days, release canceled
  390.             on FTP sites, but still avaliable though email requests.
  391.             
  392.     v1.01 -    Fixed MDEF bug that caused crashes on Mac II's and IIx's.
  393.             Refined AppleEvent code so that it actually works.
  394.  
  395.